Executes a Master Flow
{ executeMasterFlow }
Run the main flow of tasks defined in a Model file or Materialized (deployed) Model
Method
- Enterprise Admin
Input Parameters
Name
executeMasterFlowObject
Object Type
Description
Input parameters needed to execute a Master Flow
Output Response
Successful Result Code
200
Response Type
Description of Response Type
Execute master flow result
Notes
Before the execution is launched the master flow is validated. If everything is valid the master flow will be executed, otherwise it is aborted.If successful, the function's response returns the schedule ID for the execution which can be used to get the progress details (with related functions). Otherwise it returns all the validation errors.
Examples
This example demonstrates how to update data flow objects and execute flows in Pyramid.
The example uses API authentication driven from JavaScript. See Authentication APIs for alternatives.
// URL of the Pyramid installation and the path to the API 3.0 REST methods
var pyramidURL = "http://mySite.com/api3/";
const DEMO_FILE = 'url/test.pie';
const FILE_NAME = 'test';
/*
example - import master flow content, fix sources and execute
createNewFolder - f1
findRole - role1
addRoleToFolder - role1 to folder of item 1
importContent
validateMasterFlow
create server - optional
updateSourceNodeConnection
updateTargetNodeConnection
updateVariableConnection
executeMasterFlow
getMasterFlowProgressUpdate
*/
const token = callApi(
'authentication/authenticateUser',
{
userName: 'pyramid user name',
password: 'password',
},
"",
false
);
log('got token ' + token);
const defaultTenant = callApi('access/getDefaultTenant', "",token);
const tenantPublicFolder = callApi('content/getPublicOrGroupFolderByTenantId', {
validRootFolderType: 1, //the public folder of the default tenant
tenantId: defaultTenant,
},token);
const folderCreation = callApi('content/createNewFolder', {
parentFolderId: tenantPublicFolder.id,
folderName: 'new folder',
},token);
const folderId = folderCreation.modifiedList[0].id;
const findRole = callApi('access/getRolesByName', {
searchValue: 'role 1',
searchMatchType: 2, //SearchMatchType.Equals
},token);
const roleId = findRole[0].roleId;
log('found role with id= ' + roleId);
//adding the role we found to the folder we created (folderId)
roleToItemApiData: {
itemId: folderId,
roleId: roleId, //SearchMatchType.Equals
},token);
const pieFile = readPieFile(DEMO_FILE);
const importContent = callApi('content/importContent', {
rootFolderId: folderId,
fileZippedData: pieFile,
clashDefaultOption: 1, //ClashDefaultOption.REPLACE_FILE like default
rolesAssignmentType: 3, //RoleAssignmentType.ForceParentFolderRoles take roles from parent folder
},token);
log('import file completed');
//search for the item we just imported
const findContentItem = callApi('content/findContentItem', {
searchString: FILE_NAME,
filterTypes: [4], //ContentTypeObject.ETLFlow
searchMatchType: 2, //SearchMatchType.Equals
searchRootFolderType: 1, //SearchRootFolderType.Public
},token);
const itemId = findContentItem[0].id;
log('found the file by name: item ID is ' + itemId);
//validate master flow
const validationResult = callApi('dataSources/validateMasterFlow', {
itemId: itemId
},token);
// random GUID
const serverId = '7385130a-d87f-404d-816b-5c296c27b4ad';
// handle sources issues
if (validationResult.sources.length > 0) {
log('create server');
// create server (if has alreafy get it by server name)
const createResult = callApi('dataSources/createDataServers', [
{
id: serverId,
serverName: 'apiMashwinds',
serverType: 5,
serverIp: '172.29.3.219',
port: 1433,
writeCapable: 1,
securedByUser: false,
serverAuthenticationMethod: 0,
userName: 'sa',
password: 'snap3535!',
useGlobalAccount: false,
overlayPyramidSecurity: false,
},
],token);
log('fixing sources');
// In this example only the server ID is replaced, where the database remains the same
const sourceObject = validationResult.sources[0];
const modifiedItemsResult = callApi('dataSources/updateSourceNodeConnection', {
dataFlowNodeId: sourceObject.dataFlowNodeId,
serverId: serverId,
databaseName: sourceObject.databaseName,
},token);
log('fixing targets');
if (validationResult.targets.length > 0) {
const targetObject = validationResult.targets[0];
const res = callApi('dataSources/updateTargetNodeConnection', {
useExistingDatabase: false,
itemId: itemId,
dataFlowNodeId: targetObject.dataFlowNodeId,
serverId: serverId,
databaseName: 'NewDbExample',
},token);
}
log('fixing variables');
if (validationResult.variables.length > 0) {
const variableObject = validationResult.variables[0];
const res = callApi('dataSources/updateVariableConnection', {
itemId: itemId,
variableName: variableObject.variableName,
serverId: serverId,
},token);
}
log('execute master flow');
const executeMasterFlowResult = callApi('dataSources/executeMasterFlow', {
itemId: itemId,
},token);
const scheduleId = executeMasterFlowResult.scheduleId;
let inProgress = true;
let counter = 0;
// while
while (inProgress && counter < 60) {
const masterFlowProgressUpdate = callApi('dataSources/getMasterFlowProgressUpdate', scheduleId, token);
const taskStatus = masterFlowProgressUpdate.taskStatus;
if (
taskStatus == null ||
taskStatus == 0 /*TaskStatus.PENDING*/ ||
taskStatus == 4 /*TaskStatus.RUNNING*/
) {
counter++;
setTimeout(() => console.log('sleep'), 1000);
log('taskStatus: ' + taskStatus + ' counter: ' + counter);
} else {
log('Execute finish - ' + taskStatus);
inProgress = false;
}
}
log('Finished');
function log(msg) {
document.write(msg );
console.log(msg);
}
// ##### generic REST API calling method ##############
function callApi(path,data,token="",parseResult=true){
var xhttp = new XMLHttpRequest();
xhttp.open("POST", pyramidURL+path, false);
xhttp.setRequestHeader("paToken",token)
xhttp.send(JSON.stringify(data));
if(parseResult){
return JSON.parse(xhttp.responseText);
}else{
return xhttp.responseText;
}
}
function readPieFile(file) {
var rawFile = new XMLHttpRequest();
rawFile.open('GET', file, false);
rawFile.send();
if (rawFile.readyState === 4 && rawFile.status === 200) {
return rawFile.responseText;
}
}
Code Snippets
Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.
curl -X POST \
-H "paToken: [[apiKey]]" \
-H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
-H "Content-Type: application/json" \
"http://Your.Server.URL/API3/dataSources/executeMasterFlow" \
-d '{
"itemId" : "itemId",
"shouldOverrideSecurity" : true,
"processModelsOnly" : true,
"executionTitle" : "executionTitle"
}'
import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.DataSourcesServiceApi;
import java.util.*;
import java.time.*;
public class DataSourcesServiceApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://Your.Server.URL/");
// Configure API key authorization: paToken
ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
paToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//paToken.setApiKeyPrefix("Token");
// Create an instance of the API class
DataSourcesServiceApi apiInstance = new DataSourcesServiceApi();
// Initialize the executeMasterFlowObject parameter object for the call
ExecuteMasterFlowObject executeMasterFlowObject = ; // Create the input object for the operation, type: ExecuteMasterFlowObject
try {
ExecuteMasterFlowResult result = apiInstance.executeMasterFlow(executeMasterFlowObject);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DataSourcesServiceApi#executeMasterFlow");
e.printStackTrace();
}
}
}
import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";
// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.DataSourcesServiceApi("http://Your.Server.URL")
// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");
const executeMasterFlowObject = ; // {ExecuteMasterFlowObject}
api.executeMasterFlow(executeMasterFlowObject).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;
public class executeMasterFlowExample
{
public static void Main()
{
Configuration conf = new Configuration();
conf.BasePath = "http://Your.Server.URL/";
// Configure API key authorization: paToken
conf.ApiKey.Add("paToken", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// conf.ApiKeyPrefix.Add("paToken", "Bearer");
GlobalConfiguration.Instance = conf;
// Create an instance of the API class
var apiInstance = new DataSourcesServiceApi();
// Initialize the executeMasterFlowObject parameter object for the call
var executeMasterFlowObject = new ExecuteMasterFlowObject(); // ExecuteMasterFlowObject |
try {
// Run the main flow of tasks defined in a Model file or Materialized (deployed) Model
ExecuteMasterFlowResult result = apiInstance.executeMasterFlow(executeMasterFlowObject);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling DataSourcesServiceApi.executeMasterFlow: " + e.Message );
}
}
}
import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import DataSourcesServiceApi
from pprint import pprint
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
with com.pyramidanalytics.ApiClient(api_config) as api_client:
# Create an instance of the API class
api_instance = DataSourcesServiceApi(api_client)
# Initialize the executeMasterFlowObject parameter object for the call
executeMasterFlowObject = # ExecuteMasterFlowObject |
try:
# Run the main flow of tasks defined in a Model file or Materialized (deployed) Model
api_response = api_instance.execute_master_flow(executeMasterFlowObject)
pprint(api_response)
except ApiException as e:
print("Exception when calling DataSourcesServiceApi->executeMasterFlow: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataSourcesServiceApi();
$executeMasterFlowObject = ; // ExecuteMasterFlowObject |
try {
$result = $api_instance->executeMasterFlow($executeMasterFlowObject);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataSourcesServiceApi->executeMasterFlow: ', $e->getMessage(), PHP_EOL;
}
?>